Email section rewrite #1662
Email section rewrite #1662
Conversation
This is a good example of a doc that we were talking about writing, but then decided against it. It's interesting to see that the AI believes it is important. |
|
Okay, so Cursor is now catching APA style.
|
|
|
||
| Email forwarding is applied on a per-domain basis. | ||
|
|
||
|  |
There was a problem hiding this comment.
This screenshot is out of date and needs to be replaced.
|  | ||
|
|
||
| 1. **Email Forwarding** tab - Email forwarding management options for the domain. | ||
| 1. **Add email forward** button - Create a new email forward. |
|
|
||
| 1. **Email Forwarding** tab - Email forwarding management options for the domain. | ||
| 1. **Add email forward** button - Create a new email forward. | ||
| 1. **Current Email Forwards** section - List of all configured email forwards. |
There was a problem hiding this comment.
This section does exist, but it doesn't actually have a header...
|
|
||
| ## View email forwarding configuration | ||
|
|
||
|  |
There was a problem hiding this comment.
The screenshot needs to be updated
|
|
||
|  | ||
|
|
||
| 1. **From** field - The local part of the email address to forward from (e.g., `hello` for `[email protected]`). |
|
|
||
| 1. **From** field - The local part of the email address to forward from (e.g., `hello` for `[email protected]`). | ||
| 1. **To** field - The full email address where emails should be forwarded. | ||
| 1. **Add email forward** button - Creates the email forward. |
There was a problem hiding this comment.
Create forward button
| ## Catch-all email forwarding | ||
|
|
||
| To create a catch-all email forward, select the **Catch-all** option when creating a new email forward. This will forward emails sent to any address at your domain that doesn't have a specific forwarding rule. | ||
|
|
There was a problem hiding this comment.
could probably add a screenshot here
| To view all email forwards for a domain: | ||
|
|
||
| 1. Navigate to the domain's **Email Forwarding** tab. | ||
| 1. All configured email forwards are listed in the **Current Email Forwards** section. |
There was a problem hiding this comment.
this isn't totally correct
There was a problem hiding this comment.
That's true. We do not have a current email forward section.
|
|
||
| 1. Navigate to the domain's **Email Forwarding** tab. | ||
| 1. Find the email forward you want to edit in the **Current Email Forwards** section. | ||
| 1. Click **Edit** (or the pencil icon). |
There was a problem hiding this comment.
only option is pencil icon
| 1. Navigate to the domain's **Email Forwarding** tab. | ||
| 1. Find the email forward you want to edit in the **Current Email Forwards** section. | ||
| 1. Click **Edit** (or the pencil icon). | ||
| 1. Modify the **From** or **To** fields as needed. |
| To remove an email forward from your domain: | ||
|
|
||
| 1. Navigate to the domain's **Email Forwarding** tab. | ||
| 1. Locate the email forwarding configuration that you want to delete under the **Current Email Forwards** section. |
There was a problem hiding this comment.
current email forwards section isn't actually a thing...
|
|
||
| 1. Navigate to the domain's **Email Forwarding** tab. | ||
| 1. Locate the email forwarding configuration that you want to delete under the **Current Email Forwards** section. | ||
| 1. Click **Delete** (or the trash can icon). |
There was a problem hiding this comment.
only trash can icon is available
| excerpt: How to set up SPF records in your DNSimple account. | ||
| meta: Learn how to set up SPF records for email authentication and what to expect from your email provider. | ||
| categories: | ||
| - DNS |
There was a problem hiding this comment.
I like that Cursor figured out that this would also go in DNS
|
|
||
| SPF records are published as [TXT records](/articles/txt-record/) in your DNS zone. The record contains a list of IP addresses and/or hostnames that are permitted to send email from your domain. | ||
|
|
||
| <info> |
There was a problem hiding this comment.
This is also in What Is an SPF Record? article. I'm not sure if we'd want it in both places.
| v=spf1 ip4:192.0.2.1 include:_spf.google.com ~all | ||
| ``` | ||
|
|
||
| ## Understanding SPF mechanisms |
There was a problem hiding this comment.
This is in the other SPF article and could be removed.
| ### Email Hosting | ||
| - ✅ Email Hosting Support (Explanation) | ||
|
|
||
| ## Identified Gaps |
There was a problem hiding this comment.
These are all good gaps that could easily be filled/cross referenced from other categories.
| ## Notes | ||
|
|
||
| - Some topics (like MX records) exist in the DNS category but should be cross-referenced or duplicated in the Emails category for better discoverability | ||
| - One-click services for email are covered in the Services category, which is appropriate, but the Emails category should have integration guides |
There was a problem hiding this comment.
I'm not sure I agree with integration guides in Email..
| When you have a catch-all email forward, it only applies to emails sent to addresses that do not already have a specific email forward set up. If an email is sent to an address that has a matching email forward, only that email forward will handle it; the catch-all will not apply. | ||
| </info> | ||
|
|
||
| ## Email forwarding limits |
There was a problem hiding this comment.
I like that that it created a part for the email forward limits
There was a problem hiding this comment.
With the addition of the gap articles, there is now an entire article about email forwarding limits that we could link to.
content/articles/email-forwarding.md
Outdated
| To get started with email forwarding: | ||
|
|
||
| ## Internationalized Domain Names (IDN) support {#idna} | ||
| 1. Ensure you're subscribed to a plan that includes email forwarding. |
There was a problem hiding this comment.
All plans include email forwarding. Make sure you are subscribed to an active plan, the domain is delegated to DNSimple’s name servers, and DNS hosting is active.
| 1. Use the **account switcher** at the top of the page to select the appropriate account. | ||
| 1. In your **Domain Names** list, click the name of the domain where you want to create an email forward. | ||
| 1. Click the **Email Forwarding** tab on the left side. | ||
| 1. Click **Add email forward** or the **+** button. |
There was a problem hiding this comment.
Click Add email forward or the continue button.
| 1. Click the **Email Forwarding** tab on the left side. | ||
| 1. Click **Add email forward** or the **+** button. | ||
| 1. Enter the email forward details: | ||
| - **From:** Enter the local part (the part before the @) of the email address you want to forward from (e.g., `hello` for `[email protected]`). Do not include the domain name. |
There was a problem hiding this comment.
The From text when creating an email forward does not appear in the UI @sbastn. Shouldn't it be there?
|
Today, I am taking the gaps article and creating the content with Cursor. My plan is to have Cursor merge them into the email-section-rewrite branch. |
|
Okay. That added more articles than I expected. I'm not surprised there are checks failing. |
|
|
||
| ## Overview | ||
|
|
||
| The DNSimple API provides endpoints for: |
There was a problem hiding this comment.
https://developer.dnsimple.com/v2/domains/email-forwards/ lists what is available.
|
|
||
| 1. **Get an API token:** | ||
| - Log into your DNSimple account | ||
| - Go to **Account** > **Access Tokens** |
There was a problem hiding this comment.
- Go to the Account Switcher and select the account you would like the access token attached to.
- Open the Account Switcher again and select Account Settings
- On the left-hand side of the page, select Access Token
There was a problem hiding this comment.
Should this even be in a reference document as it is more of a how-to?
There was a problem hiding this comment.
I would say that this is a how to
| https://api.sandbox.dnsimple.com/v2 | ||
| ``` | ||
|
|
||
| ## Common endpoints |
There was a problem hiding this comment.
Have to check API docs to see if this is correct. Do we also want to list it all out in the reference or should we just link to the api documentation for email forwards?
|
|
||
| ### What happens when limits are reached | ||
|
|
||
| If you reach your message limit: |
|
|
||
| ### Are there limits on email size? | ||
|
|
||
| Email forwarding has size limits for individual emails. Very large emails may not be forwarded successfully. Contact support if you're experiencing issues with large emails. |
| @@ -0,0 +1,215 @@ | |||
| --- | |||
| title: Email Forwarding with Subdomains | |||
There was a problem hiding this comment.
Is this something DNSimple can even do/handle?
Update email-forwarding.md and emails.md to include all new email articles: - Added sections for managing email forwarding (limits, subdomains, multiple domains) - Added advanced topics (migration, bounces, deliverability, authentication, security) - Added email hosting integration guides - Added API documentation references - Added troubleshooting guides - Added MX records and DNS records management articles These updates organize and link to all 28 new articles created from the gap analysis.
Co-authored-by: Carla Marmolejos <[email protected]>
| - Contact your email hosting provider or check their documentation | ||
| - Obtain the DKIM selector and public key | ||
|
|
||
| 2. **Add DKIM record:** |
There was a problem hiding this comment.
link to article section for this action
| - List all services that send email on your behalf | ||
| - Include your email hosting provider, transactional email services, marketing platforms, etc. | ||
|
|
||
| 2. **Create SPF record:** |
There was a problem hiding this comment.
link to article section for this action
| - Begin with `p=none` to monitor without affecting delivery | ||
| - Set up a reporting email address using `rua=mailto:[email protected]` | ||
|
|
||
| 2. **Create DMARC record:** |
There was a problem hiding this comment.
link to article section for this action
|
|
||
| ### Check your reputation | ||
|
|
||
| 1. **Use reputation monitoring tools:** |
There was a problem hiding this comment.
links needed for these
|
|
||
| You can configure DNS records manually or use DNSimple's one-click service. | ||
|
|
||
| ### Option 1: Using the one-click service (recommended) |
There was a problem hiding this comment.
link to one-click article for this action
| - Go to your domain's **Email Forwarding** tab | ||
| - Delete all email forwards (this removes email forwarding MX records) | ||
|
|
||
| 3. **Add MX records in DNSimple:** |
There was a problem hiding this comment.
link to article section for this action
| - Click **Add record** | ||
| - Repeat for all MX records | ||
|
|
||
| 4. **Add verification TXT record (if needed):** |
|
|
||
| You can configure DNS records manually or use DNSimple's one-click service. | ||
|
|
||
| ### Option 1: Using the one-click service (recommended) |
There was a problem hiding this comment.
link to one-click article for this action
|
|
||
| ## Getting started | ||
|
|
||
| ### Step 1: Get an API token |
There was a problem hiding this comment.
steps all need editing
|
|
||
| ## Basic operations | ||
|
|
||
| ### List email forwards |
There was a problem hiding this comment.
should this link to api documentation?
| @@ -0,0 +1,282 @@ | |||
| --- | |||
| title: Managing Multiple DKIM Selectors | |||
There was a problem hiding this comment.
not sure why, but I'm recalling for some reason that we don't allow this?
Need to look into this
| - Click on your domain name from the Domain Names list | ||
| - Click the **DNS** tab | ||
|
|
||
| 2. **Remove old MX records:** |
There was a problem hiding this comment.
reword or link to article
| - Confirm deletions | ||
|
|
||
| <info> | ||
| **One-click services:** If you're using DNSimple's one-click services for your old provider, you can remove the service, which will automatically remove the associated DNS records. See [Removing Services](/articles/services/#removing-services) for instructions. |
| **Solutions:** | ||
| 1. **Verify email forwarding enabled:** Check that email forwarding is enabled in DNSimple | ||
| 2. **Check email forwards:** Verify all email forwards are configured correctly | ||
| 3. **Test DNS:** Use `dig` to verify MX records point to DNSimple |
|
|
||
| ### Sender reputation tools | ||
|
|
||
| **Sender Score (sender-score.org):** |
There was a problem hiding this comment.
this doesn't exist. URL is https://senderscore.org/
| - Monitor trends over time | ||
| - Address issues that affect score | ||
|
|
||
| **Google Postmaster Tools:** |
There was a problem hiding this comment.
| - Monitor Gmail-specific metrics | ||
| - Address Gmail-specific issues | ||
|
|
||
| **Microsoft SNDS (Smart Network Data Services):** |
There was a problem hiding this comment.
|
|
||
| ### Blacklist monitoring | ||
|
|
||
| **MXToolbox:** |
There was a problem hiding this comment.
| - Address blacklist issues immediately | ||
|
|
||
| **Other tools:** | ||
| - Spamhaus |
There was a problem hiding this comment.
|
|
||
| **Other tools:** | ||
| - Spamhaus | ||
| - BarracudaCentral |
There was a problem hiding this comment.
| **Other tools:** | ||
| - Spamhaus | ||
| - BarracudaCentral | ||
| - SURBL |
There was a problem hiding this comment.
3 participants
Start with the content from all articles in the Emails and replace the existing articles with new articles using the Diataxis framework (https://diataxis.fr/) and following the voice from articles in the DNSSEC and DNS category, . Produce a list of gaps of missing articles for the Emails category that should be added in the future based on functionality provided by DNSimple related to email. Create a new pillar page for the Emails category using https://support.dnsimple.com/articles/dnssec/ as an example template.
Using the code in dnsimple-app review the articles in the Email section and correct any outdated documentation.